Node / meshtastic / Meshtastic-Android / files / feature / firmware / src / commonMain / kotlin / org / meshtastic / feature / firmware / ota / WifiOtaDiscovery.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.firmware.ota

Tff7b72import T7ee787co.touchlab.kermit.Logger

Tff7b72import T7ee787io.ktor.network.selector.SelectorManager

Tff7b72import T7ee787io.ktor.network.sockets.InetSocketAddress

Tff7b72import T7ee787io.ktor.network.sockets.SocketAddress

Tff7b72import T7ee787io.ktor.network.sockets.aSocket

Tff7b72import T7ee787kotlinx.coroutines.withContext

Tff7b72import T7ee787kotlinx.coroutines.withTimeoutOrNull

Tff7b72import T7ee787kotlinx.io.readByteArray

Tff7b72import T7ee787org.meshtastic.core.common.util.ioDispatcher

Tff7b72import T7ee787org.meshtastic.core.common.util.safeCatching

T8b949e/**

* Listens for the ESP32 OTA loader's UDP discovery broadcast so the host can learn the device's post-reboot IP.

*

* After rebooting into OTA mode the loader emits a UDP broadcast to `255.255.255.255:[port]` every ~1 second. DHCP may

* assign a different IP in OTA mode than in normal operation, so connecting to the previously-known IP can fail; this

* discovery resolves the actual address.

*/

Tff7b72internal Tff7b72object T56d364WifiOtaDiscovery Tb4b4b4{

T8b949e/**

* Listens for the OTA loader's UDP discovery broadcast on [port] and returns the sender's IP address. Returns

* `null` on timeout, bind failure, or any other receive error — callers fall back to the original IP.

*/

Tff7b72suspend Tff7b72fun Td2a8ffdiscoverOtaDeviceTb4b4b4(

Te6edf3portTb4b4b4: Tffa657Int Tff7b72= Te6edf3WifiOtaTransportTb4b4b4.Te6edf3DEFAULT_PORTTb4b4b4,

Te6edf3timeoutMsTb4b4b4: Tffa657Long Tff7b72= Te6edf3DEFAULT_TIMEOUT_MSTb4b4b4,

Tb4b4b4)Tb4b4b4: Tffa657String? Tff7b72= Te6edf3withContextTb4b4b4(Te6edf3ioDispatcherTb4b4b4) Tb4b4b4{

T8b949e// NOTE: No MulticastLock acquired — that is an Android-only API and this is commonMain. All-ones

T8b949e// limited broadcasts (255.255.255.255) are typically delivered without it; if a specific device filters

T8b949e// them, add an expect/actual multicast-lock wrapper and acquire it for the duration of [receive].

Te6edf3safeCatching Tb4b4b4{

Te6edf3withTimeoutOrNullTb4b4b4(Te6edf3timeoutMsTb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3selector Tff7b72= Te6edf3SelectorManagerTb4b4b4(Te6edf3ioDispatcherTb4b4b4)

Tff7b72var Te6edf3discoveredTb4b4b4: Tffa657String? Tff7b72= Tff7b72null

Tff7b72try Tb4b4b4{

Tff7b72val Te6edf3socket Tff7b72= Te6edf3aSocketTb4b4b4(Te6edf3selectorTb4b4b4)Tb4b4b4.Te6edf3udpTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3bindTb4b4b4(Te6edf3InetSocketAddressTb4b4b4(Ta5d6ff"Ta5d6ff0.0.0.0Ta5d6ff"Tb4b4b4, Te6edf3portTb4b4b4)Tb4b4b4)

Tff7b72try Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3i Tb4b4b4{ Ta5d6ff"Ta5d6ffWiFi OTA: Listening for OTA device discovery broadcast on port Tffd700$Te6edf3portTa5d6ff" Tb4b4b4}

Tff7b72while Tb4b4b4(Te6edf3discovered Tff7b72=Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3datagram Tff7b72= Te6edf3socketTb4b4b4.Te6edf3receiveTb4b4b4(Tb4b4b4)

Tff7b72val Te6edf3candidate Tff7b72= Te6edf3senderHostTb4b4b4(Te6edf3datagramTb4b4b4.Te6edf3addressTb4b4b4)

Tff7b72val Te6edf3payload Tff7b72= Te6edf3datagramTb4b4b4.Te6edf3packetTb4b4b4.Te6edf3readByteArrayTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3candidate Tff7b72!Tff7b72= Tff7b72null Tff7b72&Tff7b72& Te6edf3isOtaDiscoveryBeaconTb4b4b4(Te6edf3payloadTb4b4b4)Tb4b4b4) Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3i Tb4b4b4{ Ta5d6ff"Ta5d6ffWiFi OTA: Discovered OTA device broadcastTa5d6ff" Tb4b4b4}

Te6edf3discovered Tff7b72= Te6edf3candidate

Tb4b4b4} Tff7b72else Tb4b4b4{

Te6edf3LoggerTb4b4b4.Te6edf3d Tb4b4b4{ Ta5d6ff"Ta5d6ffWiFi OTA: Ignoring non-Meshtastic OTA discovery datagramTa5d6ff" Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

Tb4b4b4} Tff7b72finally Tb4b4b4{

Te6edf3socketTb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tb4b4b4} Tff7b72finally Tb4b4b4{

Te6edf3selectorTb4b4b4.Te6edf3closeTb4b4b4(Tb4b4b4)

Tb4b4b4}

Te6edf3discovered

Tb4b4b4}

Tb4b4b4}

Tb4b4b4.Te6edf3getOrNullTb4b4b4(Tb4b4b4)

Tb4b4b4}

Tf0883e@SuppressTb4b4b4(Ta5d6ff"Ta5d6ffReturnCountTa5d6ff"Tb4b4b4) T8b949e// early-out paths for different address shapes

Tff7b72internal Tff7b72fun Td2a8ffsenderHostTb4b4b4(Te6edf3addressTb4b4b4: Te6edf3SocketAddressTb4b4b4)Tb4b4b4: Tffa657String? Tb4b4b4{

Tff7b72val Te6edf3sock Tff7b72= Te6edf3address Tff7b72as? Te6edf3InetSocketAddress Tff7b72?: Tff7b72return Tff7b72null

T8b949e// InetSocketAddress.hostname may trigger a reverse-DNS lookup; use only the raw IPv4 bytes returned by

T8b949e// resolveAddress() (4 bytes for IPv4 — the only shape ESP32 OTA loader broadcasts).

Tff7b72val Te6edf3bytes Tff7b72= Te6edf3sockTb4b4b4.Te6edf3resolveAddressTb4b4b4(Tb4b4b4)

Tff7b72if Tb4b4b4(Te6edf3bytes Tff7b72!Tff7b72= Tff7b72null Tff7b72&Tff7b72& Te6edf3bytesTb4b4b4.Te6edf3size Tff7b72=Tff7b72= Te6edf3IPV4_ADDRESS_BYTESTb4b4b4) Tb4b4b4{

Tff7b72return Te6edf3bytesTb4b4b4.Te6edf3joinToStringTb4b4b4(Ta5d6ff"Ta5d6ff.Ta5d6ff"Tb4b4b4) Tb4b4b4{ Tb4b4b4(Tffa657itTb4b4b4.Te6edf3toIntTb4b4b4(Tb4b4b4) Te6edf3and Te6edf3BYTE_MASKTb4b4b4)Tb4b4b4.Te6edf3toStringTb4b4b4(Tb4b4b4) Tb4b4b4}

Tb4b4b4}

Tff7b72return Tff7b72null

Tb4b4b4}

Tff7b72internal Tff7b72fun Td2a8ffisOtaDiscoveryBeaconTb4b4b4(Te6edf3payloadTb4b4b4: Te6edf3ByteArrayTb4b4b4)Tb4b4b4: Tffa657Boolean Tb4b4b4{

Tff7b72val Te6edf3message Tff7b72= Te6edf3payloadTb4b4b4.Te6edf3decodeToStringTb4b4b4(Tb4b4b4)Tb4b4b4.Te6edf3trimTb4b4b4(Tb4b4b4)

Tff7b72return Te6edf3OTA_DISCOVERY_PATTERNTb4b4b4.Te6edf3matchesTb4b4b4(Te6edf3messageTb4b4b4)

Tb4b4b4}

T8b949e// esp32-unified-ota broadcasts "<deviceName> <version>", where deviceName is "Meshtastic_" plus 4 MAC hex digits.

Tff7b72private Tff7b72val Te6edf3OTA_DISCOVERY_PATTERN Tff7b72= Te6edf3RegexTb4b4b4(Ta5d6ff"""Ta5d6ff^Meshtastic_[0-9A-Fa-f]{4}Ta5d6ff\Ta5d6ffs+Ta5d6ff\Ta5d6ffS{1,32}$Ta5d6ff"""Tb4b4b4)

Tff7b72private Tff7b72const Tff7b72val Te6edf3IPV4_ADDRESS_BYTES Tff7b72= T79c0ff4

Tff7b72private Tff7b72const Tff7b72val Te6edf3BYTE_MASK Tff7b72= T79c0ff0Te6edf3xFF

Tff7b72private Tff7b72const Tff7b72val Te6edf3DEFAULT_TIMEOUT_MS Tff7b72= T79c0ff3Te6edf3_000L

Tb4b4b4}